You are here: COM API reference > Server objects > AMDocumentRepository object

AMDocumentRepository object

This object represents the connection to the server. It is used to select the vault and the context to work in, and it manages the transaction that is required to access the vault.

Members (IAMDocumentRepository)
Name Description

AMFSSharePath property

Do not use this property. See IAMEdmUICache interface.

AMLicense property

The name of the License Server object for this connection.

AMServer property

Reserved. See About reserved objects, methods, and properties .

Baselines property

The baselines collection of the repository (see AMBaseline object).

Clone method

Creates a new repository transaction instance, using the same state (opened/closed) and connection parameters (when OpenRepository has been called before) as this repository.

CloseRepository method

Closes the repository.

ContextPath property

A path describing the context in which this repository is currently opened.

CreateRecoveryLogFile method

Reserved. See About reserved objects, methods, and properties .

CreationDate property

The creation date of this repository.

CurrentWorkList property

The AMWorkList object for the current user in the current work area.

CurrentWorkPackage property

The currently opened AMWorkPackage object.

DisplayName property

The descriptive name of the repository.

Environment property

A reference to the environment settings (AMEDMEnvironment object).

ExecuteQuery method

Executes the given query and returns a collection of matching documents.

GetAnyWorkPackage method

Gets any work package object by ID (see AMWorkPackage object).

GetBaseline method

Gets a baseline object by ID (see AMBaseline object).

GetBaselineByMoment method

Returns the baseline object of the current work package context, with the given Moment value (see AMBaseline object).

GetDBDriverVersionInfo method

Reserved. See About reserved objects, methods, and properties .

GetDiskSizes method

Reserved. See About reserved objects, methods, and properties .

GetFSObject method

Gets a file system object from the repository (IAMFSObject interface).

GetHistoryObjects method

Reserved. See About reserved objects, methods, and properties .

GetNavigationItems method

Reserved. See About reserved objects, methods, and properties .

GetSelection method

Gets a selection by ID (AMSelection object).

GetSubWorkPackage method

Gets a sub-work package object by ID.

GetWorkList method

Gets an AMWorkList object by ID.

IDToPath method

Gets the full path to a file or folder with the given ID.

Invalidate method

Reserved. See About reserved objects, methods, and properties .

IsOpen property

True if the repository is currently opened, False when closed.

IsRevoked property

Returns True when the transaction has been revoked.

IsUserMode property

True when the repository was opened in user mode.

LoadPropertyValues(Ex) method

Loads the values of the given set of properties for a given object.

MainWorkPackages property

The collection of main-level work areas.

MakeSelection method

Makes a new selection object from the given collection of documents (typically the collection returned by ExecuteQuery).

Moment property

Empty if the repository was opened in the present time. If this property returns a date/time, the current transaction will view the vault as it existed at that point in time.

MomentDate property

Like Moment, but this property will return the current server time instead of Empty when the transaction is in the Present time.

Name property

The internal name of the repository.

NewBaseline method

Creates a new baseline (see AMBaseline object).

NewDocument method

Creates a new AMDocument object.

NewFolder method

Creates a new AMFolder object.

NewSearchQuery method

Creates a new temporary AMSearchQuery object.

NewSelection method

Creates a new empty AMSelection object.

NewSubWorkPackage method

Creates a new AMWorkPackage object.

NextSequenceNumber method

Increments and returns the repository sequence number with the given name. See Warning.

OpenRepository method

Starts a new transaction.

OtherWLAccessRights property

Reserved. See About reserved objects, methods, and properties .

OtherWLSecurityData property

Reserved. See About reserved objects, methods, and properties .

Path property

Reserved. See About reserved objects, methods, and properties .

PathToID property

The ID of a document or folder with the given path.

Refresh method

Reserved. See About reserved objects, methods, and properties .

RemoveHistory method

Reserved. See About reserved objects, methods, and properties .

RemoveSubWorkPackage method

Removes the given work package.

ReOpen method

Closes the current transaction and starts a new transaction with the same parameters.

RequireChangeThroughSubWP property

False if documents cannot be edited in the work area. Documents should be assigned to a sub-work area first.

Reserved property

Reserved. See About reserved objects, methods, and properties .

ResetSequence method

Resets the repository sequence number with the given name to the given value. See Warning.

Root property

The root folder of the repository (AMFolder object).

SavePropertyValues method

Saves the values of the given set of properties for the given object.

Selections property

A collection in the AMSelection object in the current work area.

SequenceNumber method

Returns the repository sequence number with the given name. See Warning.

ServerTime property

The current server time in UTC.

SubWorkPackages property

The collection of sub-work package objects.

Upgrade method

Reserved. See About reserved objects, methods, and properties .

User property

User name.

UsesExternalEnvironment property

Reserved. See About reserved objects, methods, and properties .

WorkLists property

The collection of worklist objects.

Warning    Using the vault name as a sequence name can cause errors and possibly crash the EDM Server service.

Members (IAMDocumentRepository2)
Name Description

GetFullUserName method

Gets the full name of the Windows user account of the given user

CloseConnections method

Reserved. See About reserved objects, methods, and properties .

OpenRepository method

Starts a transaction in a given context

SessionIdentification property

Reserved. See About reserved objects, methods, and properties .

PatchCode property

Reserved. See About reserved objects, methods, and properties .

IsWorkIsolationMode property

True when work isolation mode has been enabled for the vault

EDMServerVersion property

Reserved. See About reserved objects, methods, and properties .

GetDistinctValues method

Returns the maximum number of values for a given property in use for all documents in the vault.

Set MaxValues to -1 to get all values used for the given property.

GetUserGroups method

Reserved. See About reserved objects, methods, and properties .

ImportDocument method

Reserved. See About reserved objects, methods, and properties .

GetVaultUsage method

Reserved. See About reserved objects, methods, and properties .

GetFolderIconIndex method

Reserved. See About reserved objects, methods, and properties .

DocumentCount property

The total number of documents in the vault

Members (IAMDocumentRepository3)
Name Description

CreateIncrementalRecoveryLogFile method

Reserved. See About reserved objects, methods, and properties .

ExecuteMultiContextQuery method

Executes a search query that can find documents in any work area

IsUniqueValue property

True if no other object in the vault has the specified value for a property

CompressDatabase method

Reserved. See About reserved objects, methods, and properties .

GetFSObjectIDWithVersionID method

Gets the Object ID for a document from the Object ID of one of its revisions

Members (IAMDocumentRepository4)
Name Description

UseObjectContext property

Reserved. See About reserved objects, methods, and properties .

ExecuteReport method

Reserved. See About reserved objects, methods, and properties .

RemoveStreamByID method

Reserved. See About reserved objects, methods, and properties .

GetServerUsers method

Reserved. See About reserved objects, methods, and properties .

LoadPropertyValues(Ex) method

Gets the values of an object for the given set of properties

CopyReferences method

Reserved. See About reserved objects, methods, and properties .

Members (IAMDocumentRepository5)
Name Description

WebAccessVirtualDirectory property

Reserved. See About reserved objects, methods, and properties .

WebAccessLocationID property

Reserved. See About reserved objects, methods, and properties .

WebAccessLocationName property

Reserved. See About reserved objects, methods, and properties .

GetWorklistFromMainArea property

Gets the Worklists collection from the Main area. See "AMWorkList object."

Members (IAMDocumentRepository6)
Name Description

HasPrivilege property

Indicates whether a user has the specified privilege

GetUserPrivileges method

Reserved. See About reserved objects, methods, and properties .

Members (IAMDocumentRepository7)
Name Description

ValidWindowsAccountName method

Reserved. See About reserved objects, methods, and properties .

Members (IAMDocumentRepository8)
Name Description

SavePropertyValues method

Saves the values of an object for the given set of properties

Members (IAMDocumentRepository9)
 Name Description

CopyReferencesEx method

Copies references and provides transaction control

Members (IAMDocumentRepository10)
 Name Description

GetInfoFlags method

Returns information flags

Members (IAMDocumentRepository11)
 Name Description

CopyReferencesEx2 method

Copies references and provides transaction control.

Members (IAMDocumentRepository12)
 Name Description

GetDocumentIDWithGlobalID method

Gets Document ID by Global ID.

ExecuteMultiContextQuery2 method

Executes the given query and returns a multi-context result. Work area is searched only when its display name matches the wildcard specification.

Members (IAMDocumentRepository13)
 Name Description

PurgeDocumentWithID method

Purges the document with the given ID from this vault.

Members (IAMDocumentRepository14)
 Name Description

EvaluateFilterQuery method

Evaluates filter conditions

Members (IAMDocumentRepository15)
 Name Description

NewConfigurableFolder method

Creates a new configurable folder.

GetCreatableFolderTypes method

Returns folder types that can be created in the parent folder.


www.bluecieloecm.com